Update Arduino IDE 2.x debugger tutorials for compatibility with versions >=2.3.0 #1792
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
A major reworking of the debugger configuration system was released in Arduino IDE 2.3.0 (arduino/arduino-ide#2281). This caused several breaking changes to the Arduino IDE user interface which rendered debugger tutorials outdated:
Tools > Programmer Menu Selection Required
The IDE is now configured for the debug probe hardware in use via the Tools > Programmer menu selection.
As a side effect of that change, it is now mandatory for the user to make the appropriate selection from that menu in order to use the debugger. If no selection is made, the IDE disables the "Start Debugging" button. For this reason, it will be important for the debugger tutorials to include this.
Arduino IDE versions prior to 2.3.0 did not use the "Programmer" selection for configuration of the debugger. Although selecting a programmer before starting the debugger is not mandatory for users of older versions of the IDE, it also will not cause any harm and that menu was present in those versions of the IDE as well. So the inclusion of a Programmer menu selection step in the tutorials does not break their compatibility with previous versions of Arduino IDE 2.x.
Change to
debug_custom.json
FormatThere was a breaking change to the data structure of the
debug_custom.json
file that allows the user to adjust the debugger configuration.The tutorial for using the IDE 2.x debugger with a J-Link debug probe requires the use of the
debug_custom.json
feature. The change to the file's data structure rendered that part of the tutorial outdated.Bug in
debug_custom.json
FeatureA regression was introduced in Arduino IDE 2.3.0 that causes the configuration defined in certain fields of
debug_custom.json
to no longer have an effect (arduino/vscode-arduino-tools#48), causing the J-Link tutorial to no longer be usable.A fix for the IDE bug is now in progress (arduino/vscode-arduino-tools#49), but it will likely be some time before this can be shipped in a new Arduino IDE release.
What This PR Changes
debug_custom.json
format.debug_custom.json
to work around tutorial-breaking IDE bug.Contribution Guidelines